Schnittstelle HighlightData

Alle Superschnittstellen:

Chunk, Serializable

public interface HighlightData
extends Chunk

This is a container to display certain highlights in the pages displayed in a GUI component.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifikator und Typ	Schnittstelle	Beschreibung
static class	HighlightData.Highlight	Represents a highlight area on a certain page.

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen Chunk

Chunk.ChunkType

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
String	getFilterKey()	Returns the key of the filter which created the highlight.
List<HighlightData.Highlight>	getPageHighlights(int pageNr, boolean firstDocument)	Returns the highlights of this container for a certain page

Von Schnittstelle geerbte Methoden Chunk

getType

Methodendetails

getPageHighlights

List<HighlightData.Highlight> getPageHighlights(int pageNr,
 boolean firstDocument)

Returns the highlights of this container for a certain page

Parameter:

pageNr - the page number, zero-based

firstDocument - true if the first document is referenced, false for the second one

Gibt zurück:

the highlights for this page, may be null if there are none

Seit:

3.0

getFilterKey

String getFilterKey()

Returns the key of the filter which created the highlight. This key is the same as ISortFilter.getExtensionName() of the source filter.

Gibt zurück:

the highlight type key, may be null for highlights that are only used internally.

Seit:

4.0